<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the NIMPCSDKOptions class from the nim_core_v2 library, for the Dart programming language.">
  <title>NIMPCSDKOptions class - nim_core_v2 library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">nim_core_v2</a></li>
    <li><a href="../nim_core_v2/nim_core_v2-library.html">nim_core.dart</a></li>
    <li class="self-crumb">NIMPCSDKOptions class</li>
  </ol>
  <div class="self-name">NIMPCSDKOptions</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="nim_core_v2&#47;nim_core_v2-library-sidebar.html"
    data-below-sidebar="nim_core_v2&#47;NIMPCSDKOptions-class-sidebar.html">
    <div>
<h1><span class="kind-class">NIMPCSDKOptions</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>桌面端初始化参数配置</p>
</section>


    <section>
      <dl class="dl-horizontal">
        
  <dt>Inheritance</dt>
  <dd>
    <ul class="gt-separated dark clazz-relationships">
      <li><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></li>
        <li><a href="../nim_core_v2/NIMSDKOptions-class.html">NIMSDKOptions</a></li>
      <li>NIMPCSDKOptions</li>
    </ul>
  </dd>

        
        


        
        
  <dt>Annotations</dt>
  <dd>
    <ul class="annotation-list clazz-relationships">
        <li>@JsonSerializable(explicitToJson: true)</li>
    </ul>
  </dd>


      </dl>
    </section>

    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>
    <dl class="constructor-summary-list">
        <dt id="NIMPCSDKOptions" class="callable">
          <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/NIMPCSDKOptions.html">NIMPCSDKOptions</a></span><span class="signature">({<span class="parameter" id="-param-basicOption"><span>required</span> <span class="type-annotation"><a href="../nim_core_v2/NIMBasicOption-class.html">NIMBasicOption</a></span> <span class="parameter-name">basicOption</span>, </span><span class="parameter" id="-param-linkOption"><span class="type-annotation"><a href="../nim_core_v2/NIMLinkOption-class.html">NIMLinkOption</a>?</span> <span class="parameter-name">linkOption</span>, </span><span class="parameter" id="-param-databaseOption"><span class="type-annotation"><a href="../nim_core_v2/NIMDatabaseOption-class.html">NIMDatabaseOption</a>?</span> <span class="parameter-name">databaseOption</span>, </span><span class="parameter" id="-param-fcsOption"><span class="type-annotation"><a href="../nim_core_v2/NIMFCSOption-class.html">NIMFCSOption</a>?</span> <span class="parameter-name">fcsOption</span>, </span><span class="parameter" id="-param-privateServerOption"><span class="type-annotation"><a href="../nim_core_v2/NIMPrivateServerOption-class.html">NIMPrivateServerOption</a>?</span> <span class="parameter-name">privateServerOption</span>, </span><span class="parameter" id="-param-appKey"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">appKey</span>, </span><span class="parameter" id="-param-sdkRootDir"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">sdkRootDir</span></span>})</span>
        </dt>
        <dd>
          
        </dd>
        <dt id="NIMPCSDKOptions.fromMap" class="callable">
          <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/NIMPCSDKOptions.fromMap.html">NIMPCSDKOptions.fromMap</a></span><span class="signature">(<span class="parameter" id="fromMap-param-map"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a></span> <span class="parameter-name">map</span></span>)</span>
        </dt>
        <dd>
          
            <div class="constructor-modifier features">factory</div>
        </dd>
    </dl>
  </section>
    
  <section
      class="summary offset-anchor"
      id="instance-properties">
    <h2>Properties</h2>
    <dl class="properties">
        <dt id="appKey" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/appKey.html">appKey</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  

</dt>
<dd class="inherited">
  app key
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="basicOption" class="property">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/basicOption.html">basicOption</a></span>
  <span class="signature">&#8596; <a href="../nim_core_v2/NIMBasicOption-class.html">NIMBasicOption</a></span>
  

</dt>
<dd>
  基础配置
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="cdnTrackInterval" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/cdnTrackInterval.html">cdnTrackInterval</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a>?</span>
  

</dt>
<dd class="inherited">
  cdn统计回调触发间隔。触发cdn拉流前设置，触发拉流后改动将不生效
windows&amp;macos 暂不支持
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="customClientType" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/customClientType.html">customClientType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a>?</span>
  

</dt>
<dd class="inherited">
  自定义客户端类型，小于等于0视为没有自定义类型
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="databaseOption" class="property">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/databaseOption.html">databaseOption</a></span>
  <span class="signature">&#8596; <a href="../nim_core_v2/NIMDatabaseOption-class.html">NIMDatabaseOption</a>?</span>
  

</dt>
<dd>
  数据库配置
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="enableAnimatedImageThumbnail" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enableAnimatedImageThumbnail.html">enableAnimatedImageThumbnail</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  默认情况下，从服务器获取原图缩略图时，如果原图为动图，我们将返回原图第一帧的缩略图。
而开启这个选项后，我们将返回缩略图后的动图。
这个选项只影响从服务器获取的缩略图，不影响本地生成的缩略图。默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="enableDatabaseBackup" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enableDatabaseBackup.html">enableDatabaseBackup</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否开启数据库备份功能，默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="enableFcs" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enableFcs.html">enableFcs</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  

</dt>
<dd class="inherited">
  是否开启融合存储,仅支持Android，iOS
  <div class="features"><span class="feature">getter/setter pair</span><span class="feature">inherited</span></div>

</dd>

        <dt id="enablePreloadMessageAttachment" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enablePreloadMessageAttachment.html">enablePreloadMessageAttachment</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否需要SDK自动预加载多媒体消息的附件。
如果打开，SDK收到多媒体消息后，图片和视频会自动下载缩略图，音频会自动下载文件。
如果关闭，第三方APP可以只有决定要不要下载以及何时下载附件内容，典型时机为消息列表第一次滑动到
这条消息时，才触发下载，以节省用户流量。
默认打开。
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="enableReportLogAutomatically" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enableReportLogAutomatically.html">enableReportLogAutomatically</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否开启IM日志自动上报，默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="enableTeamMessageReadReceipt" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/enableTeamMessageReadReceipt.html">enableTeamMessageReadReceipt</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否启用群消息已读功能，默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="fcsOption" class="property">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/fcsOption.html">fcsOption</a></span>
  <span class="signature">&#8596; <a href="../nim_core_v2/NIMFCSOption-class.html">NIMFCSOption</a>?</span>
  

</dt>
<dd>
  融合存储配置
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

        <dt id="linkOption" class="property">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/linkOption.html">linkOption</a></span>
  <span class="signature">&#8596; <a href="../nim_core_v2/NIMLinkOption-class.html">NIMLinkOption</a>?</span>
  

</dt>
<dd>
  连接相关配置
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="loginCustomTag" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/loginCustomTag.html">loginCustomTag</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span>
  

</dt>
<dd class="inherited">
  登录时的自定义字段，登陆成功后会同步给其他端
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="nosSceneConfig" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/nosSceneConfig.html">nosSceneConfig</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../nim_core_v2/NIMNosScene.html">NIMNosScene</a></span>, <span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span>?</span>
  

</dt>
<dd class="inherited">
  SDK nos 场景配置
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="privateServerOption" class="property">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/privateServerOption.html">privateServerOption</a></span>
  <span class="signature">&#8596; <a href="../nim_core_v2/NIMPrivateServerOption-class.html">NIMPrivateServerOption</a>?</span>
  

</dt>
<dd>
  私有化配置
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
  

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

        <dt id="sdkRootDir" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/sdkRootDir.html">sdkRootDir</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span>
  

</dt>
<dd class="inherited">
  sdk 根目录
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="serverConfig" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/serverConfig.html">serverConfig</a></span>
  <span class="signature">&#8594; <a href="../nim_core_v2/NIMServerConfig-class.html">NIMServerConfig</a>?</span>
  

</dt>
<dd class="inherited">
  配置专属服务器的地址
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="shouldConsiderRevokedMessageUnreadCount" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/shouldConsiderRevokedMessageUnreadCount.html">shouldConsiderRevokedMessageUnreadCount</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  开启时，如果被撤回的消息本地还未读，那么当消息发生撤回时，
对应会话的未读计数将减 1 以保持最近会话未读数的一致性。默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="shouldSyncStickTopSessionInfos" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/shouldSyncStickTopSessionInfos.html">shouldSyncStickTopSessionInfos</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否同步置顶会话记录，默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="shouldSyncUnreadCount" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/shouldSyncUnreadCount.html">shouldSyncUnreadCount</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否开启会话已读多端同步，支持多端同步会话未读数，默认关闭
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="shouldTeamNotificationMessageMarkUnread" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/shouldTeamNotificationMessageMarkUnread.html">shouldTeamNotificationMessageMarkUnread</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  群通知消息是否计入未读数，默认不计入未读
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="useAssetServerAddressConfig" class="property inherited">
  <span class="name"><a href="../nim_core_v2/NIMSDKOptions/useAssetServerAddressConfig.html">useAssetServerAddressConfig</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a>?</span>
  

</dt>
<dd class="inherited">
  是否使用自定义服务器地址配置文件
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="toMap" class="callable">
  <span class="name"><a href="../nim_core_v2/NIMPCSDKOptions/toMap.html">toMap</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter">dynamic</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">override</span></div>

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
    
    

  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../index.html">nim_core_v2</a></li>
    <li><a href="../nim_core_v2/nim_core_v2-library.html">nim_core_v2</a></li>
    <li class="self-crumb">NIMPCSDKOptions class</li>
</ol>

    <h5>nim_core_v2 library</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div>
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    nim_core_v2
      10.9.2-ohos-beta
  </span>
  
</footer>


<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>

</body>
</html>

